game/2006Scape Server/src/main/java/org/apollo/net/codec/login/LoginResponse.java

package org.apollo.net.codec.login;

/**
 * Represents a login response.
 *
 * @author Graham
 */
public final class LoginResponse {

	/**
	 * The flagged flag.
	 */
	private final boolean flagged;

	/**
	 * The rights level.
	 */
	private final int rights;

	/**
	 * The login status.
	 */
	private final int status;

	/**
	 * Creates the login response.
	 *
	 * @param status The login status.
	 * @param rights The rights level.
	 * @param flagged The flagged flag.
	 */
	public LoginResponse(int status, int rights, boolean flagged) {
		this.status = status;
		this.rights = rights;
		this.flagged = flagged;
	}

	/**
	 * Gets the rights level.
	 *
	 * @return The rights level.
	 */
	public int getRights() {
		return rights;
	}

	/**
	 * Gets the status.
	 *
	 * @return The status.
	 */
	public int getStatus() {
		return status;
	}

	/**
	 * Checks if the player should be flagged.
	 *
	 * @return The flagged flag.
	 */
	public boolean isFlagged() {
		return flagged;
	}

}